/*
Copyright (c) 2009, Young Digital Planet SA
All rights reserved.

* Redistribution and use in source and binary forms, with or without 
  modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this 
  list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, 
  this list of conditions and the following disclaimer in the documentation 
  and/or other materials provided with the distribution.
* Neither the name of the Young Digital Planet SA nor the names of its 
  contributors may be used to endorse or promote products derived from this 
  software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
POSSIBILITY OF SUCH DAMAGE.
*/
package pl.ydp.jobs
{
	import flash.errors.IllegalOperationError;
	
	import pl.ydp.jobs.basic.YJobManager;
		
	/**
	 * Jobs framework constansts.
	 */
	public class YJobs
	{
		/**
		 * @eventType jobStarted
		 */
		public static const JOB_STARED:String = "jobStarted";
		/**
		 * @eventType jobDone
		 */
		public static const JOB_DONE:String = "jobDone";
		/**
		 * @eventType jobCancelled
		 */
		public static const JOB_CANCELLED:String = "jobCancelled";
		/**
		 * @eventType jobAddPart
		 */
		public static const JOB_ADD_PART:String = "jobAddPart";
		/**
		 * @eventType jobAdded
		 */
		public static const JOB_ADDED:String = "jobAdded";
		/**
		 * @eventType jobRemoved
		 */
		public static const JOB_REMOVED:String = "jobRemoved";
		
		/**
		 * Property name for allWorked PropertyChangeEvent
		 */
		public static const ALL_WORKED:String = "allWorked";
		
		/**
		 * Property name for allTotalWork PropertyChangeEvent
		 */
		public static const ALL_TOTAL_WORK:String = "allTotalWork";
		
		/**
		 * Constant for unknown totalWork
		 * @see pl.ydp.jobs.IJobControl#totalWork
		 */
		public static const WORK_UNKNOWN:int = -1;
		
		/**
		 * Separates sections in <tt>job id</tt>. Simplest jobs id
		 * has sections:<ul>
		 * <li>subject of the job (extension/page/test/someview)
		 * <li>work that subject is executing
		 * </ul>
		 * Sections are sperated by this separator. I.e.:
		 * <tt>test:load</tt>, <tt>stylesheet:load</tt>, <tt>layout:update</tt>.
		 * In each section description should come from more general term to 
		 * specific, i.e.: <tt>media.movie:load</tt>, <tt>media.sound:load.file</tt>
		 * @see pl.ydp.jobs.IJobInfo#jobId
		 */
		public static const JOB_ID_SEPARATOR:String = ":";
		
		private static var m_appManager:IJobManager = null;
		
		/**
		 * Get application job manager. Application manager can only be set once,
		 * before any use.
		 */
		static  public function get applicationManager():IJobManager {
			if ( m_appManager==null )
				m_appManager = new YJobManager();
			
			return m_appManager;
		}
		
		static public function set applicationManager( man:IJobManager ):void {
			if ( m_appManager!=null )
				throw new IllegalOperationError( "Application manager can only be set once, before use" );
			
			m_appManager = man;	
		}
		
		static public function makeId( subject:String, work:String ):String {
			return subject+JOB_ID_SEPARATOR+work;
		}
	}
}